home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / CONVERTR / TXT2HTML / DESC.TXT next >
Encoding:
Text File  |  1995-09-09  |  3.5 KB  |  86 lines
  1. Text to HTML converter
  2.  
  3. txt2html is a filter that will convert plain, ordinary, text to HTML.
  4.  
  5. My intent in writing this tool is to provide an easier way of converting
  6. existing text documents to HTML format. txt2html can also be used to aid in
  7. writing new HTML documents, but there are probably better ways of doing
  8. that.
  9.  
  10. If you need to convert something other than plain text to HTML, or you need
  11. to convert from HTML, you should look for a more appropriate tool.
  12.  
  13. You can search these pages.
  14.  
  15. How to Install txt2html
  16.  
  17. It's a Perl script, so installation is trivial.
  18.  
  19.   1.  Get a copy of the script
  20.   2.  Make sure you can run it. On unix systems, try: chmod 555 txt2html
  21.  
  22. How to Use txt2html
  23.  
  24. It's a simple filter that takes a plain text file on stdin, and outputs
  25. HTML on stdout. One of these days I'll put file i/o options in there, but
  26. it hasn't seemed very important. (If you disagree, tell me, and I'll move
  27. it higher on my to-do list.)
  28.  
  29. So what does all this mean? Well, if you are in a standard Unix shell or
  30. MS-DOS, you would do something like this:
  31. txt2html < someTextFile > yourNewHTMLfile
  32.  
  33. More Help
  34.  
  35. The most popular request for txt2html is documentation. Ok, I'm a lout.
  36. There's still no documentation. I have a few suggestions for learning how
  37. to use txt2html.
  38.  
  39.    *  txt2html --help
  40.      This will give you a list of options. You probably won't ever need to
  41.      use more than a few of these. Most of them are for tweaking various
  42.      features. Most text files I've tried this on convert decently without
  43.      tweaking, but I'm a big fan of configurability, so I threw tons of
  44.      options in.
  45.    *  Look at the sample down below. It's not much of a guide in how to use
  46.      txt2html, but it will show you what sort of things it can handle.
  47.    *  Read the Configurable Options section at the beginning of the script.
  48.      That's where you'll find a more complete description of all the
  49.      options, as well as the default values for everything.
  50.    *  "Use the source."
  51.      I try to comment my code, but I still don't recommend this route for
  52.      the faint of heart.
  53.  
  54. sample document
  55.  
  56.    *  Plain text copy (before conversion)
  57.    *  HTML copy (after conversion)
  58.  
  59. Future Plans
  60.  
  61. The current version is v1.10, which was released on 15 Dec 1994. A list of
  62. all my changes can be found within the script itself.
  63.  
  64. txt2html isn't nearly as robust as I'd like it to be, though it's getting
  65. there. If it isn't converting your text as well as you'd like it to, please
  66. send me a sample copy along with your ideas of what it should have done
  67. with it.
  68.  
  69. If you have suggestions, complaints, questions, or just want to say hi,
  70. please feel free to send me some mail. I am planning on (finally) putting
  71. out another version of this fairly soon, which will include many fixes and
  72. a couple new features (such as automatic linking of things). The more
  73. people who express interest in this, the faster I'll get it out the door.
  74.  
  75. A few people have suggested that I add some sort of table-of-contents
  76. generator to txt2html. I believe that's the role of a decent browser, so I
  77. probably won't add that. (I'm also reluctant because of performance
  78. reasons.) Earl Hood's htmltoc will probably do what you want.
  79.  
  80. Thanks
  81.  
  82. Thanks to all the people who have given me ideas for improvements.
  83. ---------------------------------------------------------------------------
  84. seth@cs.wustl.edu
  85. Last modified: Fri Sep 1 14:23:31 1995
  86.